Dokumentation UDA-Plugin

Dokumentation UDA-Plugin

0... Allgemeines zum UDA-Plugin

0.1    Aufbau der Softwareeinheit

0.2    Schnittstellen zum Rahmenwerk

1... Perspektive „UDA-Perspektive“

1.1    Ansichten der Perspektive „UDA-Perspektive“

1.1.1      Ansicht „UDA-Modul-Navigator“

1.1.1.1    Kontextmenüs des „UDA-Modul-Navigators“

1.1.1.1.1               Kontextmenü für UDA-Modul-Objekte

1.1.1.1.1.1         Skript anlegen

1.1.1.1.1.2         Skriptlauf anlegen

1.1.1.1.1.2.1    Dialogteil 1 (Skriptlaufeigenschaften)

1.1.1.1.1.2.2    Dialogteil 2 (Authentifizierung beim Datenverteiler)

1.1.1.1.1.2.3    Dialogteil 3 (Skriptlauf-Protokolle)

1.1.1.1.1.2.4    Dialogteil 4 (Skriptlauf-Ausführungsregime)

1.1.1.1.1.2.5    Dialogteil 5 (Nutzerinformationen)

1.1.1.1.2               Kontextmenü für Skript-Objekte

1.1.1.1.2.1         Skript anlegen

1.1.1.1.2.2         Skript bearbeiten

1.1.1.1.2.3         Skriptlauf anlegen

1.1.1.1.2.4         Skriptstatus ändern

1.1.1.1.2.5         Element entfernen

1.1.1.1.2.6         Skripttext bearbeiten

1.1.1.1.2.7         Skript prüfen

1.1.1.1.3               Kontextmenü für Skriptlauf-Objekte

1.1.1.1.3.1         Skript anlegen

1.1.1.1.3.2         Skriptlauf anlegen

1.1.1.1.3.3         Skriptlauf bearbeiten

1.1.1.1.3.4         Element entfernen

1.1.1.1.3.5         Skriptlauf starten

1.1.1.1.3.6         Skriptlauf beenden

1.1.1.1.3.7         Skriptlaufausgaben anzeigen

1.1.2      Ansicht „Skriptlauf-Übersicht“

1.1.3      Ansicht „Skriptlaufausgaben“

1.1.4      Skripttext-Editor

 

0                                   Allgemeines zum UDA-Plugin

Das UDA-Plugin für das Datenverteiler-Rahmenwerk realisiert eine Mensch-Maschine-Schnittstelle, welche dem Nutzer die Möglichkeit zur Bedienung und Visualisierung der Softwareeinheit „Umfassende Datenanalyse“ (UDA) bietet (SWE 6.3 (UDA) siehe [SwEnt_SWE6.3_LosC1C2_VRZ3] bzw. [BetrInf_SWE6.3_LosC1C2_VRZ3]). Es werden folgende Funktionen zur Verfügung gestellt:

Die Bedienelemente können über die vom Rahmenwerk definierten Schnittstellen in eine potentielle Bedienoberfläche eingebunden und in das Datenverteiler-System integriert werden.

0.1                               Aufbau der Softwareeinheit

Das UDA-Plugin setzt sich analog zum Rahmenwerk aus den folgenden  Elementen zusammen:

·                     Ansichten sind Fenster in denen Daten der Anwendung angezeigt werden und manipuliert werden können. Es können allgemein beliebig viele Ansichten innerhalb des Hauptfensters positioniert werden. Die Positionierung kann vom Anwender durch einfache Mausoperationen angepasst werden. Alle Ansichten enthalten am unteren rechten Seitenrand folgende drei Schaltflächen:

Legende:

·         OK: Löst hier keine Aktion aus.

·         Schließen: Schließt die Ansicht.

·         Hilfe: Öffnet die Kontexthilfe für diese Ansicht.

·                     Perspektiven sind bestimmte funktionale Anordnungen von Ansichten. Es gibt eine vordefinierte UDA-Perspektive, welche alle UDA-Ansichten funktional miteinander verbunden integriert.  Der Nutzer kann auch selbst für seine Anforderungen Perspektiven aus den zur Verfügung stehenden Ansichten zusammenstellen und diese unter einem Namen sichern.

·                     Menüs enthalten Funktionen zur Bedienung des UDA-Plugins.

 

Zusätzlich zu den im Hauptfenster enthaltenen Elementen erfolgt die Kommunikation mit dem Nutzer über verschiedene Dialogfenster. Dabei stehen grundsätzlich folgende Typen zur Verfügung:

·                     Meldungsdialoge sind Dialogfenster, die dem Nutzer Meldungen des UDA-Plugins übermitteln und nur entsprechend bestätigt werden müssen.

·                     Wizards sind Dialogfenster über die der Anwender bestimmte Funktionen, die nähere Informationen erfordern ausführen kann. Innerhalb des Wizards erfolgt die Prüfung der vom Anwender eingegebenen Informationen und letztendlich wird die Ausführung der entsprechenden Funktion veranlasst.

 

Die Bedienung erfolgt grundsätzlich per Maus. Die meisten Funktionen sind jedoch auch über Tastatur ausführbar.

0.2                               Schnittstellen zum Rahmenwerk

Alle wesentlichen Bedienelemente dieses Plugins sind mit dem Rahmenwerk über IDs verknüpft. Diese IDs ermöglichen die Einbindung der Bedienelemente (Ansichten, Aktionen aus Menüs) in neu gestaltete Menüs bzw. Taskleisten. Die Gestaltung erfolgt über die Perspektive „Menüeditor“ des Rahmenwerks.

Die ID aller dem Rahmenwerk zur Verfügung stehenden Bedienelemente des UDA-Plugins beginnt stets mit

 

de.bsvrz.buv.plugin.uda…

 

Die Rahmenwerk ID eines Bedienelementes ist im Folgenden jeweils grau untersetzt direkt nach der Überschrift zum Element eingetragen.

Abbildung 1.1: Zur Verfügung stehende Oberflächenelemente des UDA-Plugins für den Menüeditor.

1                                   Perspektive „UDA-Perspektive“

Innerhalb der „UDA-Perspektive“ (Perspektiven, siehe Abschnitt 1.1) sollen grundsätzlich alle in Abschnitt 1 beschriebenen Funktionalitäten zusammengefasst werden. Dazu sind innerhalb dieser Perspektive eine Reihe von Ansichten definiert (siehe Abschnitt 2.1). Diese Ansichten sind aber auch unabhängig von der „UDA-Perspektive“ abrufbar.

 

Abbildung 2.1: UDA-Perspektive.

1.1                               Ansichten der Perspektive „UDA-Perspektive“

Die UDA-Perspektive enthält drei Ansichten und einen Editor. Diese Elemente sind jeweils auch einzeln über das Rahmenwerk administrierbar. Alle Elemente enthalten eine kontextsensitive Hilfe welche über F1 bzw. über die Schaltfläche „Hilfe“ aufrufbar ist.

 

Abbildung 2.2: Beispiel für Kontext-Hilfesystem für Aufruf aus Skripttext-Editor.

1.1.1                           Ansicht „UDA-Modul-Navigator“

Rahmenwerk-ID: de.bsvrz.buv.plugin.navigator.UdaModulNavigator

 

Innerhalb der Ansicht „UDA-Modul-Navigator“ werden sämtliche im verbundenen Datenverteiler konfigurierten UDA-Module (Objekte vom Typ typ.udaModul) angezeigt. Unterhalb jedes UDA-Moduls werden die diesem Modul zugeordneten UDA-Skripte und UDA-Skriptläufe in Baumstruktur visualisiert.

Die Darstellung der Objekte im Baum folgt der Struktur UDA-Modul à Skripte à Skriptläufe bzw. UDA-Modul à Skripte / Skriptläufe (da Skriptläufe nicht notwendigerweise einem Skript zugeordnet sein müssen, kann ein Skriptlauf auch direkt unterhalb eines UDA-Moduls im Baum eingehangen sein [auf der gleichen Ebene wie die Skripte selbst]).

 

Abbildung 2.3: Beispielansicht UDA-Modul-Navigator.

Legende:

1.1.1.1                      Kontextmenüs des „UDA-Modul-Navigators“

Für alle Objekte innerhalb der Baumstruktur der Ansicht „UDA-Modul-Navigator“ steht ein Kontextmenü zur Verfügung, das die speziell für das ausgewählte Objekt ausführbaren Aktionen bereitstellt. Das Kontextmenü kann über einen einfachen Mausklick auf die rechte Maustaste über dem entsprechenden Objekt (und für dieses Objekt) angezeigt werden.

1.1.1.1.1                Kontextmenü für UDA-Modul-Objekte

Ein Uda-Modul repräsentiert eine Sammelstelle für alle von der Umfassenden Datenanalyse verwalteten Skripte und der dazugehörigen Skriptläufe. Das Objekt kann entweder als Stand-Alone-Objekt konfiguriert werden bzw. ist das Basisobjekt einer Autarken Organisationseinheit.

 

 

 

Abbildung 2.4: Kontextmenü für UDA-Modul-Objekte.

1.1.1.1.1.1           Skript anlegen

Rahmenwerk-ID: de.bsvrz.buv.plugin.actions.CreateSkriptCommand

 

Diese Aktion dient dem Anlegen eines neuen UDA-Skripts. Zu diesem Zweck wird nach dem Aufruf folgender Dialog angezeigt über den alle wesentlichen Skript-Informationen einzugeben sind:

 

Abbildung 2.5: Dialog zur Eingabe der Skriptinformationen.

Parameter:

 

Durch Betätigung der Schaltfläche Fertigstellen wird das Skript angelegt (siehe Abbildung 2.6). Durch Betätigung der Schaltfläche Abbrechen wird der Vorgang abgebrochen.

Abbildung 2.6: Modul-Navigator vor und nach dem Anlegen des Skriptes aus Abbildung 2.5.

1.1.1.1.1.2           Skriptlauf anlegen

Rahmenwerk-ID: de.bsvrz.buv.plugin.actions.CreateSkriptLaufCommand

 

Diese Aktion dient dem Anlegen eines neuen UDA-Skriptslaufs. Zu diesem Zweck wird nach dem Aufruf folgender Dialog angezeigt über den alle wesentlichen Skriptlauf-Informationen einzugeben sind:

Abbildung 2.7: Gliederung des Dialogs zur Eingabe der Skriptlaufinformationen.

 

Durch Betätigung der Schaltfläche Fertigstellen wird schließlich der Skriptlauf angelegt. Durch Betätigung der Schaltfläche Abbrechen wird der Vorgang abgebrochen.

1.1.1.1.1.2.1     Dialogteil 1 (Skriptlaufeigenschaften)

In diesem Dialogteil sind folgende Informationen einzugeben:

Ein UDA-Skript „ausgabe parameter.p1 & " " & parameter.p2“ würde dann die   Ausgabe „Hallo Welt!“ erzeugen.

1.1.1.1.1.2.2     Dialogteil 2 (Authentifizierung beim Datenverteiler)

In diesem Dialogteil sind folgende Informationen einzugeben:

1.1.1.1.1.2.3     Dialogteil 3 (Skriptlauf-Protokolle)

In diesem Dialogteil kann eine beliebige Anzahl von Protokollen festgelegt werden, in welche die Ausgaben eines Skriptlaufs geschrieben werden sollen.

 

Protokolltypen:

 

Schaltflächen:

 

Durch Betätigung der Schaltfläche Fertigstellen wird das Protokoll angelegt. Durch Betätigung der Schaltfläche Abbrechen wird der Vorgang abgebrochen.

 

Abbildung 2.8: Dialog zum Anlegen eines neuen Protokolls für einen Skriptlauf.

1.1.1.1.1.2.4     Dialogteil 4 (Skriptlauf-Ausführungsregime)

In diesem Dialogteil sind folgende Informationen einzugeben:

in der die zyklische Ausführung zum ersten Mal stattfinden soll.

·         Intervall: Dieser Parameter wird nur bei zyklischer Ausführung ausgewertet. Hier gibt er an, aller wie viel Millisekunden das Skript neu ausgeführt werden soll.

1.1.1.1.1.2.5     Dialogteil 5 (Nutzerinformationen)

In diesem Dialogteil sind folgende Informationen einzugeben:

1.1.1.1.2                Kontextmenü für Skript-Objekte

Ein UDA-Skript-Objekt ist ein Objekt, das sämtliche Informationen zur Funktionalität eines UDA-Skriptes wie zum Beispiel seinen Quelltext besitzt.

Abbildung 2.9: Kontextmenü für UDA-Skript-Objekte.

1.1.1.1.2.1           Skript anlegen

Siehe Abschnitt 2.1.1.1.1.1.

1.1.1.1.2.2           Skript bearbeiten

Rahmenwerk-ID: de.bsvrz.buv.plugin.actions.EditSkriptCommand

 

Bei der Auswahl dieser Aktion wird ein Dialog analog dem in Abschnitt 2.1.1.1.1.1 geöffnet. Die einzelnen Dialogfelder sind bereits mit den Eigenschaften des selektierten Skriptes vorausgefüllt.

1.1.1.1.2.3           Skriptlauf anlegen

Siehe Abschnitt 2.1.1.1.1.2.

1.1.1.1.2.4           Skriptstatus ändern

Bei der Auswahl dieser Aktion wird ein Dialog geöffnet mit dem sich der Bearbeitungsstatus eines UDA-Skriptes ändern lässt (siehe Abbildung 2.10). In diesem Dialog sind folgende Informationen einzugeben:

 

Durch Betätigung der Schaltfläche Fertigstellen wird die Änderung des Bearbeitungsstatus übernommen. Durch Betätigung der Schaltfläche Abbrechen wird der Vorgang abgebrochen.

 

 

Abbildung 2.10: Dialog zum Ändern des Bearbeitungsstatus eines UDA-Skriptes.

1.1.1.1.2.5           Element entfernen

Rahmenwerk-ID: de.bsvrz.buv.plugin.actions.RemoveSkriptElementCommand

 

Durch die Auswahl dieser Aktion kann das aktuell selektierte UDA-Skript gelöscht werden. Vor dem Löschen findet eine Sicherheitsabfrage statt die bestätigt werden muss.

Die diesem Skript zugeordneten Skriptläufe bleiben bei dieser Aktion erhalten. Nach dem Löschen sind sie keinem Skript mehr zugeordnet und werden deshalb im UDA-Modul-Navigator direkt unterhalb des UDA-Moduls eingehangen.

1.1.1.1.2.6           Skripttext bearbeiten

Rahmenwerk-ID: de.bsvrz.buv.plugin.actions.EditSkriptTextCommand

 

Öffnet einen Editor zum Bearbeiten des Skripttextes (siehe Abschnitt 2.1.4).

1.1.1.1.2.7           Skript prüfen

Durch die Auswahl dieser Aktion wird der Quelltext des aktuell selektierten UDA-Skriptes auf syntaktische Fehler überprüft. Sollten syntaktische Fehler gefunden worden sein, so wird der erste gefundene Fehler über ein Meldungsfenster illustriert (siehe Abbildung 2.11)

Abbildung 2.11: Beispielfehlermeldung nach Syntaxüberprüfung.

1.1.1.1.3                Kontextmenü für Skriptlauf-Objekte

Ein Skriptlauf-Objekt ist ein Objekt zur Beschreibung der Ausführungsumgebung eines UDA-Skripts.

Abbildung 2.12: Kontextmenü für UDA-Skriptlauf-Objekte.

1.1.1.1.3.1           Skript anlegen

Siehe Abschnitt 2.1.1.1.1.1.

1.1.1.1.3.2           Skriptlauf anlegen

Siehe Abschnitt 2.1.1.1.1.2.

1.1.1.1.3.3           Skriptlauf bearbeiten

Rahmenwerk-ID: de.bsvrz.buv.plugin.actions.EditSkriptLaufCommand

 

Durch die Auswahl dieser Aktion kann der aktuell selektierte Skriptlauf editiert werden. Zum Editieren öffnet sich die der gleiche Dialog wie in Abschnitt 2.1.1.1.1.2. Der Dialog ist mit den Eigenschaften des aktuellen Skriptlaufes vorausgefüllt und kann analog Abschnitt 2.1.1.1.1.2 editiert werden.

1.1.1.1.3.4           Element entfernen

Rahmenwerk-ID: de.bsvrz.buv.plugin.actions.EditSkriptLaufCommand

 

Durch die Auswahl dieser Aktion kann der aktuell selektierte UDA-Skriptlauf gelöscht werden. Vor dem Löschen findet eine Sicherheitsabfrage statt die bestätigt werden muss.

1.1.1.1.3.5           Skriptlauf starten

Rahmenwerk-ID: de.bsvrz.buv.plugin.actions.EditSkriptStartenCommand

 

Startet den ausgewählten Skriptlauf, so dieser freigegeben ist und nicht bereits läuft.

1.1.1.1.3.6           Skriptlauf beenden

Rahmenwerk-ID: de.bsvrz.buv.plugin.actions.SkriptLaufBeendenCommand

 

Beendet den ausgewählten Skriptlauf, so dieser bereits läuft.

1.1.1.1.3.7           Skriptlaufausgaben anzeigen

Rahmenwerk-ID: de.bsvrz.buv.plugin.actions.SkriptLaufViewCommand

 

Bei Auswahl dieser Aktion wird die Ansicht „Skriptlaufausgaben“ (siehe Abschnitt 2.1.3) für diesen Skriptlauf anzeigt. Sollte für diesen Skriptlauf ein Dav-Protokoll angelegt worden sein (siehe Abschnitt 2.1.1.1.1.2.3), so werden die in dieses Dav-Protokoll geloggten Ausgaben dieses Skriptlaufs innerhalb der Ansicht „Skriptlaufausgaben“ ausgegeben.

1.1.2                           Ansicht „Skriptlauf-Übersicht“

Rahmenwerk-ID: de.bsvrz.buv.plugin.views.SkriptLaufUebersicht

 

Über die Ansicht „Skriptlauf-Übersicht“ kann der aktuelle Ausführungszustand aller Skriptläufe sowie deren Ergebnis angezeigt werden.

Die einzelnen Spalten haben folgende Bedeutung:

 

Diese Informationen werden gleichzeitig farblich wie folgt illustriert:

 

Farbe

Bedeutung

Blau

Skriptlauf ist nicht aktiv und das letzte Ergebnis ist OK.

Rot

Skriptlauf ist nicht aktiv und das letzte Ergebnis ist nicht OK.

Grün

Skriptlauf ist aktiv.

Grau

Skript ist nicht freigegeben bzw. Skriptlauf ist keinem Skript zugeordnet.

Tabelle 2.1: Farbzuordnung innerhalb der Ansicht „Skriptlauf-Übersicht“.

Abbildung 2.13: Beispielansicht „Skriptlauf-Übersicht“.

1.1.3                           Ansicht „Skriptlaufausgaben“

Rahmenwerk-ID: de.bsvrz.buv.plugin.views.LaufLogSicht

 

In einer Instanz der Ansicht „Skriptlaufausgaben“ werden jeweils die Ausgaben eines Skriptlaufs in den Datenverteiler angezeigt. D.h. alles, was in einem UDA-Skript über das Schlüsselwort ausgabe publiziert wird. Damit diese Skriptlaufausgaben hier angezeigt werden können, muss für den fraglichen Skriptlauf ein Dav-Protokoll erstellt worden sein (siehe Abbildung 2.14).

Abbildung 2.14: Ausschnitt aus dem Dialog zum Bearbeiten des Skriptlaufs mit einem angelegten Dav-Protokoll mit 100 Zeilen.

 

Abbildung 2.15: Beispielansicht „Skriptlaufausgaben“ für einen Skriptlauf „Lauf1“.

1.1.4                           Skripttext-Editor

Mit dem Skripttext-Editor kann der Quelltext eines UDA-Skriptes betrachtet bzw. bearbeitet werden. Dabei wird ein schwaches Syntax-Highlighting wie folgt realisiert:

 

Farbe

Bedeutung

Magenta

Schlüsselworte von UDA: aktuell, aktualisierung, alle, als, anmeldung, ausgabe, ausnahme, bedingung, benutze, bei, bis, dann, debug, definition, dem, den, der, die, div, ein, eine, einen, elemente, empfaenger, empfänger, ende, erfuellt, erfüllt, falsch, fehlerausgabe, fehlerBehandlung, fehlerpruefung, fehlerprüfung, fehlerrueckgabe, fehlerrückgabe, fuer, für, funktion, gilt, gruppe, hoechstens, höchstens, in, initial, ist, iteration, jede, jeden, jedes, jeweils, menge, mengenAenderung, mengenÄnderung, Millisekunden, Millisekunde, mindestens,       Minuten, Minute, mit, modulo, nicht, oder, ohne, quantor, quelle, rueckgabe, rückgabe, schrittweite,        Sekunden, Sekunde, sender, senke, solange, sonst, Stunden, Stunde, Tage, Tag, timer, ueber, über, und, undefiniert, von, versuche, wahr, wenn, zeile, zyklisch

Blau

alle Zeichenketten

Grau

alle Kommentare

Schwarz

alle restlichen Skriptelemente

Tabelle 2.2: Syntax-Highlighting innerhalb des Skripttext-Editors.

Zum Speichern des Skriptes muss die Schaltfläche Speichern des Rahmenwerks betätigt werden (). Es öffnet sich dann folgender Dialog (siehe Abbildung 2.16). In diesem Dialog sind folgende Informationen einzugeben:

 

Durch Betätigung der Schaltfläche Fertigstellen wird die Änderung des Bearbeitungsstatus übernommen. Durch Betätigung der Schaltfläche Abbrechen wird der Vorgang abgebrochen.

 

 

Abbildung 2.16: Dialog zum Speichern eines UDA-Skriptes.

 

Abbildung 2.17: Beispiel des Skripttext-Editors für ein Skript „Hallo“.